get /cloud/aws/securitygroups
List AWS Security Groups (getAwsSecurityGroups)
Lists the AWS Security Groups.
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Query parameters
region (required)
Query Parameter — AWS region
vpc (required)
Query Parameter — VPC
credentialsName (required)
Query Parameter — Cloud credentials name
Return type
array[SecurityGroup]
|
id (optional) |
String Security group ID |
||||
|
name (optional) |
String Security group name |
||||
|
location (optional) |
String Security group location |
||||
|
tags (optional) |
array[Tag]
|
Example data
Content-Type: application/json
[
{
"id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/Velostrata-datacenter-123465789-1234-9876/providers/Microsoft.Network/networkSecurityGroups/My-SG",
"name": "MY-SG",
"location": "eastus",
"tags": [
{
"key": "Owner",
"value": "Velostrata"
}
]
}
]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK
Default
Error ErrorInfo
|
errorCode (optional) |
String |
|
url(optional) |
String |
|
message (optional) |
String |